|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface providing special access for configuring workbench windows.
Window configurer objects are in 1-1 correspondence with the workbench
windows they configure. Clients may use get/setData
to
associate arbitrary state with the window configurer object.
Note that these objects are only available to the main application (the plug-in that creates and owns the workbench).
This interface is not intended to be implemented by clients.
IWorkbenchConfigurer#getWorkbenchWindowConfigurer
,
WorkbenchAdvisor.preWindowOpen(org.eclipse.ui.application.IWorkbenchWindowConfigurer)
Method Summary | |
void |
addEditorAreaTransfer(Transfer tranfer)
Adds the given drag and drop Transfer type to the ones
supported for drag and drop on the editor area of this workbench window. |
void |
configureEditorAreaDropListener(DropTargetListener dropTargetListener)
Configures the drop target listener for the editor area of this workbench window. |
IActionBarConfigurer |
getActionBarConfigurer()
Returns the action bar configurer for this workbench window. |
Object |
getData(String key)
Returns the data associated with this workbench window at the given key. |
boolean |
getShowCoolBar()
Returns whether the underlying workbench window has a cool bar. |
boolean |
getShowMenuBar()
Returns whether the underlying workbench window has a title bar. |
boolean |
getShowShortcutBar()
Returns whether the underlying workbench window has a shortcut bar. |
boolean |
getShowStatusLine()
Returns whether the underlying workbench window has a status line. |
boolean |
getShowTitleBar()
Returns whether the underlying workbench window has a title bar. |
String |
getTitle()
Returns the title of the underlying workbench window. |
IWorkbenchWindow |
getWindow()
Returns the underlying workbench window. |
IWorkbenchConfigurer |
getWorkbenchConfigurer()
Returns the workbench configurer. |
void |
setData(String key,
Object data)
Sets the data associated with this workbench window at the given key. |
void |
setShowCoolBar(boolean show)
Sets whether the underlying workbench window has a cool bar. |
void |
setShowMenuBar(boolean show)
Sets whether the underlying workbench window has a menu bar. |
void |
setShowShortcutBar(boolean show)
Sets whether the underlying workbench window has a shortcut bar. |
void |
setShowStatusLine(boolean show)
Sets whether the underlying workbench window has a status line. |
void |
setShowTitleBar(boolean show)
Sets whether the underlying workbench window has a title bar. |
void |
setTitle(String title)
Sets the title of the underlying workbench window. |
Method Detail |
public IWorkbenchWindow getWindow()
public IWorkbenchConfigurer getWorkbenchConfigurer()
public IActionBarConfigurer getActionBarConfigurer()
public String getTitle()
public void setTitle(String title)
Note that the window can have a title even if the window's title bar is not visible.
title
- the window title#showTitleBar
public boolean getShowTitleBar()
The initial value is controlled by the preference
IWorkbenchPreferences.SHOULD_SHOW_TITLE_BAR
true
for a title bar, and false
for no title barpublic void setShowTitleBar(boolean show)
show
- true
for a title bar, and false
for no title barpublic boolean getShowMenuBar()
The initial value is controlled by the preference
IWorkbenchPreferences.SHOULD_SHOW_MENU_BAR
true
for a title bar, and false
for no title barpublic void setShowMenuBar(boolean show)
show
- true
for a menu bar, and false
for no menu barpublic boolean getShowCoolBar()
The initial value is controlled by the preference
SHOULD_SHOW_TOOL_BAR
true
for a cool bar, and false
for no cool barpublic void setShowCoolBar(boolean show)
show
- true
for a cool bar, and false
for no cool barpublic boolean getShowShortcutBar()
The initial value is controlled by the preference
SHOULD_SHOW_SHORTCUT_BAR
true
for a shortcut bar, and false
for no shortcut barpublic void setShowShortcutBar(boolean show)
show
- true
for a shortcut bar, and false
for no shortcut barpublic boolean getShowStatusLine()
The initial value is controlled by the preference
SHOULD_SHOW_STATUS_LINE
true
for a status line, and false
for no status linepublic void setShowStatusLine(boolean show)
show
- true
for a status line, and false
for no status linepublic Object getData(String key)
key
- the key
null
if there is no data at the given
keypublic void setData(String key, Object data)
key
- the keydata
- the data, or null
to delete existing datapublic void addEditorAreaTransfer(Transfer tranfer)
Transfer
type to the ones
supported for drag and drop on the editor area of this workbench window.
The workbench advisor would ordinarily call this method from the
preWindowOpen
callback.
A newly-created workbench window supports no drag and drop transfer
types. Adding EditorInputTransfer.getInstance()
enables IEditorInput
s to be transferred.
Note that drag and drop to the editor area requires adding one or more
transfer types (using addEditorAreaTransfer
) and
configuring a drop target listener
(with configureEditorAreaDropListener
)
capable of handling any of those transfer types.
configureEditorAreaDropListener(org.eclipse.swt.dnd.DropTargetListener)
,
EditorInputTransfer
public void configureEditorAreaDropListener(DropTargetListener dropTargetListener)
The workbench advisor ordinarily calls this method from the
preWindowOpen
callback.
A newly-created workbench window has no configured drop target listener for its
editor area.
Note that drag and drop to the editor area requires adding one or more
transfer types (using addEditorAreaTransfer
) and
configuring a drop target listener
(with configureEditorAreaDropListener
)
capable of handling any of those transfer types.
dropTargetListener
- the drop target listener that will handle
requests to drop an object on to the editor area of this windowaddEditorAreaTransfer(org.eclipse.swt.dnd.Transfer)
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |